Other Constants
The following constants are available globally.
-
Posted by the shared
MGLOfflineStorage
object when anMGLOfflinePack
object’s progress changes. The progress may change due to a resource being downloaded or because the pack discovers during the download that more resources are required for offline viewing. This notification is posted whenever any field in theprogress
property changes.The
object
is theMGLOfflinePack
object whose progress changed. TheuserInfo
dictionary contains the pack’s current state in theMGLOfflinePackStateUserInfoKey
key and details about the pack’s current progress in theMGLOfflinePackProgressUserInfoKey
key. You may also consult the pack’sstate
andprogress
properties, which provide the same values.If you only need to observe changes in a particular pack’s progress, you can alternatively observe KVO change notifications to the pack’s
progress
key path.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackProgressChangedNotification
Swift
let MGLOfflinePackProgressChangedNotification: String
-
Posted by the shared
MGLOfflineStorage
object whenever anMGLOfflinePack
object encounters an error while downloading. The error may be recoverable and may not warrant the user’s attention. For example, the pack’s implementation may attempt to re-request failed resources based on an exponential backoff strategy or upon the restoration of network access.The
object
is theMGLOfflinePack
object that encountered the error. TheuserInfo
dictionary contains the error object in theMGLOfflinePackErrorUserInfoKey
key.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackErrorNotification
Swift
let MGLOfflinePackErrorNotification: String
-
Posted by the shared
MGLOfflineStorage
object when the maximum number of Mapbox-hosted tiles has been downloaded and stored on the current device.The
object
is theMGLOfflinePack
object that reached the tile limit in the course of downloading. TheuserInfo
dictionary contains the tile limit in theMGLOfflinePackMaximumCountUserInfoKey
key.Once this limit is reached, no instance of
MGLOfflinePack
can download additional tiles from Mapbox APIs until already downloaded tiles are removed by calling the-[MGLOfflineStorage removePack:withCompletionHandler:]
method. Contact your Mapbox sales representative to have the limit raised.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackMaximumMapboxTilesReachedNotification
Swift
let MGLOfflinePackMaximumMapboxTilesReachedNotification: String
-
The key for an
NSNumber
object that indicates an offline pack’s current state. This key is used in theuserInfo
dictionary of anMGLOfflinePackProgressChangedNotification
notification. Call-integerValue
on the object to receive theMGLOfflinePackState
-typed state.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackStateUserInfoKey
Swift
let MGLOfflinePackStateUserInfoKey: String
-
The key for an
NSValue
object that indicates an offline pack’s current progress. This key is used in theuserInfo
dictionary of anMGLOfflinePackProgressChangedNotification
notification. Call-MGLOfflinePackProgressValue
on the object to receive theMGLOfflinePackProgress
-typed progress.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackProgressUserInfoKey
Swift
let MGLOfflinePackProgressUserInfoKey: String
-
The key for an
NSError
object that is encountered in the course of downloading an offline pack. This key is used in theuserInfo
dictionary of anMGLOfflinePackErrorNotification
notification. The error’s domain isMGLErrorDomain
. SeeMGLErrorCode
for possible error codes.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackErrorUserInfoKey
Swift
let MGLOfflinePackErrorUserInfoKey: String
-
The key for an
NSNumber
object that indicates the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device. This key is used in theuserInfo
dictionary of anMGLOfflinePackMaximumMapboxTilesReachedNotification
notification. Call-unsignedLongLongValue
on the object to receive theuint64_t
-typed tile limit.Declaration
Objective-C
extern NSString *const _Nonnull MGLOfflinePackMaximumCountUserInfoKey
Swift
let MGLOfflinePackMaximumCountUserInfoKey: String
-
A version number identifying the default version of the suite of default styles provided by Mapbox. This version number may be passed into one of the “StyleURLWithVersion” class methods of MGLStyle.
The value of this constant generally corresponds to the latest released version as of the date on which this SDK was published. You can use this constant to ascertain the style used by
MGLMapView
andMGLTilePyramidOfflineRegion
when no style URL is specified. Consult the Mapbox Styles API documentation for the most up-to-date style versioning information.Warning
The value of this constant may change in a future release of the SDK. If you use any feature that depends on a specific aspect of a default style – for instance, the minimum zoom level that includes roads – you may use the current value of this constant or the underlying style URL, but do not use the constant itself. Such details may change significantly from version to version.Declaration
Objective-C
static const NSInteger MGLStyleDefaultVersion = 9
Swift
let MGLStyleDefaultVersion: Int
-
Indicates an error occurred in the Mapbox SDK.
Declaration
Objective-C
extern NSString *const _Nonnull MGLErrorDomain
Swift
let MGLErrorDomain: String
-
The default deceleration rate for a map view.
Declaration
Objective-C
extern const CGFloat MGLMapViewDecelerationRateNormal
Swift
let MGLMapViewDecelerationRateNormal: CGFloat
-
A fast deceleration rate for a map view.
Declaration
Objective-C
extern const CGFloat MGLMapViewDecelerationRateFast
Swift
let MGLMapViewDecelerationRateFast: CGFloat
-
Disables decleration in a map view.
Declaration
Objective-C
extern const CGFloat MGLMapViewDecelerationRateImmediate
Swift
let MGLMapViewDecelerationRateImmediate: CGFloat
-
Project version number for Mapbox.
Declaration
Objective-C
extern double MapboxVersionNumber
Swift
var MapboxVersionNumber: Double
-
Project version string for Mapbox.
Declaration
Objective-C
extern const unsigned char MapboxVersionString[]